JAMS REST API Web Service
PostSubmit_PostSubmit

Resource Path: /JAMS/APIHelp/docs/V6/api/submit

Uri: http://left/JAMS/APIHelp/docs/V6/api/submit

Description
Submit the job specified in the SubmitInfo object. Usually, you create the SubmitInfo object by calling GetSubmit which returns a SubmitInfo. You can then modify values in the SubmitInfo before calling PutSubmit.
Request

The request body is of type SubmitInfo.

A SubmitInfo object

Overview

SubmitInfo
afterTimeUTC : string
batchQueueID : integer
batchQueueName : string
debugMode : boolean
description : string
failShort : boolean
folderID : integer
folderName : string
hold : boolean
jamsEntry : integer
jamsId : string
jobs : Array[SubmitJob]
agentNode : string
allowEditSource : boolean
altUserName : string
batchQueueID : integer
batchQueueName : string
description : string
detailID : integer
folderID : integer
folderName : string
hold : boolean
inSchedule : boolean
jobID : integer
keepLogs : string
logFile : boolean
logFilename : string
logLocation : string
minimumSeverity : string
missedWindowAction : string
name : string
notifyOfMissedWindow : boolean
notifyUser : boolean
overrideName : string
precheckInterval : string
precheckJobID : integer
requiresSnapshot : boolean
restartable : boolean
runawayElapsed : string
runPriority : integer
scheduleFromTime : string
scheduleToTime : string
scheduleWindowID : integer
schedulingPriority : integer
shortElapsed : string
shortSeverity : string
source : string
sourceModified : boolean
stalledTime : string
step : integer
submitMethodID : integer
timestampLogs : string
userID : integer
userName : string
waitFor : boolean
logFile : boolean
logFilename : string
logLocation : string
manageAccess : boolean
missedWindowAction : string
name : string
note : string
notifyOfMissedWindow : boolean
notifyUser : boolean
overrideName : string
parameters : Array[SubmitParameter]
allowEntry : boolean
dataType : string
defaultFormat : string
detailID : integer
globalName : string
globalOverride : boolean
helpText : string
hide : boolean
jobID : integer
length : integer
mustFill : boolean
parameterOrigin : string
paramID : integer
paramName : string
paramValue : string
prompt : string
required : boolean
uppercase : boolean
validationData : string
validationType : string
precheckInterval : string
precheckJobID : integer
restartable : boolean
resultText : string
retainOption : string
retainTime : string
ron : integer
runawayElapsed : string
scheduleFromTime : string
scheduleToTime : string
scheduleWindowID : integer
schedulingPriority : integer
setSymbols : boolean
shortElapsed : string
stalledTime : string
submitID : integer
submitIsSimple : boolean
submittedBy : string
submitType : string
suppressNotify : boolean
testSubmit : boolean
timestampLogs : string
userID : integer
userName : string
useSymbols : boolean
Response

The response body is of type SubmitInfo.

OK

Overview

SubmitInfo
afterTimeUTC : string
batchQueueID : integer
batchQueueName : string
debugMode : boolean
description : string
failShort : boolean
folderID : integer
folderName : string
hold : boolean
jamsEntry : integer
jamsId : string
jobs : Array[SubmitJob]
agentNode : string
allowEditSource : boolean
altUserName : string
batchQueueID : integer
batchQueueName : string
description : string
detailID : integer
folderID : integer
folderName : string
hold : boolean
inSchedule : boolean
jobID : integer
keepLogs : string
logFile : boolean
logFilename : string
logLocation : string
minimumSeverity : string
missedWindowAction : string
name : string
notifyOfMissedWindow : boolean
notifyUser : boolean
overrideName : string
precheckInterval : string
precheckJobID : integer
requiresSnapshot : boolean
restartable : boolean
runawayElapsed : string
runPriority : integer
scheduleFromTime : string
scheduleToTime : string
scheduleWindowID : integer
schedulingPriority : integer
shortElapsed : string
shortSeverity : string
source : string
sourceModified : boolean
stalledTime : string
step : integer
submitMethodID : integer
timestampLogs : string
userID : integer
userName : string
waitFor : boolean
logFile : boolean
logFilename : string
logLocation : string
manageAccess : boolean
missedWindowAction : string
name : string
note : string
notifyOfMissedWindow : boolean
notifyUser : boolean
overrideName : string
parameters : Array[SubmitParameter]
allowEntry : boolean
dataType : string
defaultFormat : string
detailID : integer
globalName : string
globalOverride : boolean
helpText : string
hide : boolean
jobID : integer
length : integer
mustFill : boolean
parameterOrigin : string
paramID : integer
paramName : string
paramValue : string
prompt : string
required : boolean
uppercase : boolean
validationData : string
validationType : string
precheckInterval : string
precheckJobID : integer
restartable : boolean
resultText : string
retainOption : string
retainTime : string
ron : integer
runawayElapsed : string
scheduleFromTime : string
scheduleToTime : string
scheduleWindowID : integer
schedulingPriority : integer
setSymbols : boolean
shortElapsed : string
stalledTime : string
submitID : integer
submitIsSimple : boolean
submittedBy : string
submitType : string
suppressNotify : boolean
testSubmit : boolean
timestampLogs : string
userID : integer
userName : string
useSymbols : boolean
See Also
All Operations Resource GroupJAMS REST API Web Service

 

 


© 2017 All Rights Reserved.

Send comments on this topic.